Rules

Type: array

List of rules. Rules are an encapsulation for a list of actions to perform if the rule condition passes

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

A rule encapsulates a set of actions to perform when the rule's condition is true

No Additional Properties

Name of the Rule

Type: string

A string that represents the name of the rule.

Type: string

Defines a unique identifier for this rule

Description of the Rule

Type: string

A string that represents the description of the rule.

Type: array of string

A list of stages that this specific stage depends on ie its parents that must be executed first before it gets executed. Rule dependencies can only be actions and not other rules

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string) Default: "0"

Defines whether this rule should be skipped or not. If skipped, all the actions under this rule will be skipped

Must be one of:

  • "0"
  • "1"

Type: object

Always True Condition

Type: const
Specific value: "always"

No Condition

Type: const
Specific value: ""

Existence Checker Condition

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "exists"
  • "not exists"

True/False Condition

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "true"
  • "false"

Simple Condition

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "=="
  • "!="
  • "gt"
  • "gte"
  • "lt"
  • "lte"
  • "contains"
  • "not contains"
  • "matches"
  • "not matches"
  • "regex"
  • "in"
  • "not in"
  • "in list all"
  • "not in list all"
  • "in list any"
  • "not in list any"
  • "like"
  • "validates"
  • "not validates"

Type: object

List of Textual Values

Type: array of string
No Additional Items

Each item of this array must be:

List of Objects

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Each additional property must conform to the following schema

Type: string

Value from Path

Type: object
No Additional Properties

Validation Data

Type: array of object
No Additional Items

Each item of this array must be:

Simple Condition for Similarity

Type: object

Uses Fuzzy string matching to calculate similarity between strings

No Additional Properties

Type: enum (of string)

Must be one of:

  • "similar_to"

Type: string

Minimum Fuzzy Ratio between 0-100 (similarity score) for condition to be true

Type: enum (of string) Default: "0"

Must be one of:

  • "1"
  • "0"

Nested Conditions

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "AND"
  • "OR"

Join Condition

Type: object
No Additional Properties


Must not be:

Type: enum (of string)

Must be one of:

  • "exists"
  • "not exists"

Condition for Set Function (no path)


Simple

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "=="
  • "!="
  • "gt"
  • "gte"
  • "lt"
  • "lte"
  • "contains"
  • "not contains"
  • "matches"
  • "not matches"
  • "regex"
  • "in"
  • "not in"
  • "in list all"
  • "not in list all"
  • "in list any"
  • "not in list any"
  • "like"
  • "similar_to"

Existence Checker

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "exists"
  • "not exists"

True/False

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "true"
  • "false"

List of Actions

Type: array

An array of actions to be executed in order.

All items must be unique

No Additional Items

Each item of this array must be:


Type: object

Type: object

Type: string

Defines a unique identifier for this rule

Type: string

The description of what the arithmetic action does

Type: array

A list of stages that this specific stage depends on ie its parents that must be executed first before it gets executed. Rule dependencies can only be actions and not other rules

No Additional Items

Type: enum (of string)

Defines whether this rule should be skipped or not. If skipped, all the actions under this rule will be skipped

Must be one of:

  • "0"
  • "1"
Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "add"
  • "subtract"
  • "multiply"
  • "divide"
Type: object

Type: object

Action Parameters

Type: string

The (part of) data the function will operate on

Type: string, array or object

The value to be used as the argument for the operation.

Type: string

The field from which to derive the value for the operation.

Type: string

The field to store the result of the operation.

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "set"
Type: object

Type: object

Type: string

The data path where the value is to be set.

Type: string, array, object or null

The value to set. Optional if using valueFromField.

Type: string

The JSON path from which to copy a value. Optional if using value.

Type: string, object or null Default: ""

Maps values from valueFromField to new values. Used only with valueFromField.

Type: array of object

Sets the value based on a condition.

No Additional Items

Each item of this array must be:

Type: object

Type: string, array, object or null

The value to set if the condition is true.

Type: string

The field from which to derive the value if the condition is true. Optional.

Type: string

The new field to create or update with the set value.

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "system_defined_function"


Prompt Search

Type: object
No Additional Properties

Type: const

Must be one of:

  • "prompt_search"
Specific value: "prompt_search"

Type: object
No Additional Properties

Type: object
No Additional Properties

Type: array of array
No Additional Items

Each item of this array must be:

Prompt Match

Type: object
No Additional Properties

Type: const

Must be one of:

  • "prompt_match"
Specific value: "prompt_match"

Type: object
No Additional Properties

Prompt Classification

Type: object
No Additional Properties

Type: const

Must be one of:

  • "prompt_classification"
Specific value: "prompt_classification"
Type: object

Type: object

Type: object

Type: object


Regex Mapper

Type: object

Type: object
No Additional Properties


Key-Value Mapping

Type: object

Key-Value where key represents the search pattern and value represents the replacement

Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: object

Simple Condition

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "=="
  • "!="
  • ">"
  • ">="
  • "<"
  • "<="
  • "in"
  • "not in"
  • "regex"
  • "true"
  • "false"
  • "empty"
  • "not empty"
  • "startswith"
  • "endswith"
  • "similar_to"
  • "gt"
  • "gte"
  • "lt"
  • "lte"
  • "contains"
  • "not contains"
  • "matches"
  • "not matches"
  • "no tin"
  • "in list all"
  • "not in list all"
  • "in list any"
  • "not in list any"
  • "like"
Type: object

Type: object

Type: object

Type: object

Split or group data

Type: object
No Additional Properties

Type: enum (of string)

The method of splitting

Must be one of:

  • ""
  • "running_total"

Type: string

The path that determines the criteria for splitting. Akin to 'groupBy'

Type: string

The max totals per group when doing group by running totals

Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: object

The criteria to use for joining

No Additional Properties

Type: enum (of string)

Must be one of:

  • "inner"
  • "left"
  • "right"

Type: array of string

List of fields to group the data by

No Additional Items

Each item of this array must be:

Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: string

The data path where the value is to be set.

Type: string, array, object or null

The value to set. Optional if using valueFromField.

Type: string

The JSON path from which to copy a value. Optional if using value.

Type: string, object or null Default: ""

Maps values from valueFromField to new values. Used only with valueFromField.

Type: array of object

Sets the value based on a condition.

No Additional Items

Each item of this array must be:

Type: string

The new field to create or update with the set value.

Type: object

Type: object

Type: object

Type: object

Type: object

Used to concatenate lists of data. Different from merge in that it simply appends one list to another

No Additional Properties

Type: array of string

Paths to the subsets of data to be concatenated

No Additional Items

Each item of this array must be:

Type: object

The conditions to be met for the joining to be done. Two datasets are only merged if both meet the criteria

Same definition as condition
Type: object

Type: object

Type: object

Type: object


Gets one value from a list of data, based on the specified reducer function

Min or Max

Type: object

Get the min or max value from the data

No Additional Properties

Modal or Priority Reducer

Type: object

Modal returns the most common value and if there is a tie, it uses the priority list to break the tie. Priority reducer picks the data with the highest priority

No Additional Properties

Type: enum (of string)

Must be one of:

  • "modal_value"
  • "priority_reducer"

Get item at index

Type: object

Returns a specific item at a given index in the list

No Additional Properties

Type: object

Type: object

Type: object
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "fuzzy_extract_one"

Type: object
No Additional Properties

Type: enum (of string) Default: "tokenSetRatio"

Must be one of:

  • "ratio"
  • "partialRatio"
  • "weightedRatio"
  • "tokenSetRatio"
  • "tokenSortRatio"
  • "tokenSetPartialRatio"
  • "tokenSortPartialRatio"
Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string) Default: "tokenSetRatio"

Must be one of:

  • "ratio"
  • "partialRatio"
  • "weightedRatio"
  • "tokenSetRatio"
  • "tokenSortRatio"
  • "tokenSetPartialRatio"
  • "tokenSortPartialRatio"
Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string) Default: "tokenSetRatio"

Must be one of:

  • "ratio"
  • "partialRatio"
  • "weightedRatio"
  • "tokenSetRatio"
  • "tokenSortRatio"
  • "tokenSetPartialRatio"
  • "tokenSortPartialRatio"
Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string) Default: "tokenSetRatio"

Must be one of:

  • "ratio"
  • "partialRatio"
  • "weightedRatio"
  • "tokenSetRatio"
  • "tokenSortRatio"
  • "tokenSetPartialRatio"
  • "tokenSortPartialRatio"
Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: string Default: "0"

The number, from 1, of the capture group for backreference

Type: enum (of string) Default: "1"

If no search matches the pattern, whether or not to return the whole data

Must be one of:

  • "1"
  • "0"
Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string) Default: "1"

Can be used when condition is set. Should be true when the condition specifies a path that should be referenced in the data

Must be one of:

  • "1"
  • "0"

Type: string

Used when appending data within a list of objects. The key specifies which object key the final result should be set in

Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string) Default: "1"

Can be used when condition is set. Should be true when the condition specifies a path that should be referenced in the data

Must be one of:

  • "1"
  • "0"

Type: string

Used when appending data within a list of objects. The key specifies which object key the final result should be set in

Type: object

Type: object

Type: object

Type: object

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • ""
  • "brackets"
  • "square brackets"
  • "curly brackets"
  • "forward strokes"
  • "backward strokes"
  • "double quotes"
  • "single quotes"
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "concat_multi_array_assoc"

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • ""
  • "brackets"
  • "square brackets"
  • "curly brackets"
  • "forward strokes"
  • "backward strokes"
  • "double quotes"
  • "single quotes"
Type: object

Type: object
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "regex_mapper_multiple"

Type: object
No Additional Properties

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Use this for sorting which mapper is to be executed before which ones

Type: object
No Additional Properties

Type: object
Type: object

Type: object
Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Expands complex nested array into a simple one-level array of objects. Nested objects are brought to the parent level. Nested arrays are expanded and split eg ['preferences' => ['colors' => ['blue', 'green']]] becomes [['preferences.colors' => 'blue'],['preferences.colors' => 'green']]

No Additional Properties

Type: object

Type: object

Type: object

Type: object

Type: object
Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Convert quantity from one unit to another. Must take in a valid conversion table as the data. A valid conversion table is a list of objects with object keys: to (unit to convert to), from (unit to convert from), factor (the conversion multiple between the from and to units). Example: {'from': 'cm', 'to': 'm', 'factor': 0.01}

No Additional Properties

Type: enum (of string)

Whether or not the factor in conversion table should be inverted or not

Must be one of:

  • "1"
  • "0"

Type: enum (of string) Default: "up"

How to handle decimals ie round off, round up or round down

Must be one of:

  • "up"
  • "down"
  • "off"

Type: string Default: "0"

The number of decimal places when rounding off

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "convert_unit_multi"

Type: object

Convert units similar to convert_unit function but working on a list of objects data.

No Additional Properties

Type: enum (of string) Default: "0"

Whether or not the factor in conversion table should be inverted or not

Must be one of:

  • "1"
  • "0"

Type: enum (of string) Default: "up"

How to handle decimals ie round off, round up or round down

Must be one of:

  • "up"
  • "down"
  • "off"

Type: string Default: "0"

The number of decimal places when rounding off

Type: string

The field path where the conversion results will be stored

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Convert from one data model to another

No Additional Properties


The keys define the source data paths while the values define the mapped (new) data paths

Type: enum (of string)

If inverted is yes, the mapping is done in the opposite direction ie model mapping keys will be the new data while values will be source data paths

Must be one of:

  • "1"
  • "0"
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "make_object_list_unique"

Type: object

Returns a list with all duplicate objects removed to ensure objects are unique

No Additional Properties

Type: string

Key/field for ranking to choose on which copy of the duplicated objects to retain

Type: enum (of string) Default: "desc"

The ranking ordr for the rankkeypath

Must be one of:

  • "desc"
  • "asc"
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "duplicate_list_item"

Type: object

Duplicate specific objects within a list. Has an option to modify the duplicated copy

No Additional Properties

Type: string

The search key used to match the duplicated object to its replacement data

Type: array of object

The replacement data. For each replacement, add a new property defining the replacement_key name used for search

No Additional Items

Each item of this array must be:

Type: object

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "basic_arithmetic"
Type: object
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "parse_template"

Type: object
No Additional Properties

Type: string

Template text where variables are denoted as {{variable_name}}

Type: array of object

Configure how the template variables in the template should matched. Number of configs should equal the number of template variables in the regex template

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "strtolower"
  • "strtoupper"
  • "trim"
  • "ucwords"
  • "strlen"
  • "explode"
  • "implode"
  • "nl2br"
  • "number_format"
  • "levenshtein"
  • "similar_text"
  • "soundex"
  • "str_contains"
  • "str_ireplace"
  • "str_replace"
  • "substr"
  • "strtr"
  • "strtotime"
  • "sort"
  • "round"
  • "floor"
  • "ceil"
  • "abs"
  • "exp"
  • "max"
  • "min"
  • "pow"
  • "sqrt"
  • "array_sum"
  • "count"
  • "sizeof"
  • "json_encode"
  • "json_decode"
  • "intval"
  • "floatval"
  • "preg_match"
  • "preg_replace"
  • "date_default_timezone_set"
Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "pattern_based_stem_spell_corrections"

Type: object
No Additional Properties
Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "validate_data_structure"

Type: object

Type: object

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "map"
  • "map_parallel"

Type: object